home *** CD-ROM | disk | FTP | other *** search
/ Precision Software Appli…tions Silver Collection 1 / Precision Software Applications Silver Collection Volume One (PSM) (1993).iso / windows / games / iedit.exe / IEDIT.DOC < prev    next >
Text File  |  1990-10-10  |  16KB  |  312 lines
  1.                               IEdit Shareware
  2.                                 Version 2.2
  3.  
  4.      Welcome to IEdit, and I hope you'll register!  This new version is a
  5. major revision of IEdit, and I hope you enjoy it.  New features include:
  6.  
  7. * New icon-based function selection
  8. * Icon scrolling in any direction
  9. * An "Undo" function
  10. * A built in file length check guards against viruses
  11. * A "Change a Color" function to alter a color over an entire icon
  12. * "Quick Help" for functions with a single mouse click
  13.  
  14.  
  15.     The Enhanced version of IEdit has the following new features: 
  16.  
  17. * A View function to preview your icon in a Windows-style dialog box
  18. * Graphic Load function lets you pick your icon visually
  19. * A "Best Guess" invert mask function
  20. * Invert Mask editing
  21. * "Rotate" turns your icon 90° clockwise
  22. * A Grid for precise icons
  23. * A shell to DOS for quick jumps to the DOS command line
  24. * "Mirror" function makes symmetric icons easier
  25. * A scroll "Chain" to link or unlink icon and invert mask scrolling
  26. * Uses 80286 instructions for speed (8088 version available)
  27.  
  28. You will find IEdit's Help function contains much of the information below.
  29.  
  30.  
  31.                                 Introduction
  32.  
  33.      IEdit is a full featured tool for creating and editing icons for the
  34. Microsoft Windows environment.  IEdit itself however, is a DOS application.
  35. As many users know, IEdit is released in two versions, a Shareware version
  36. (IEDIT.EXE), and an Enhanced version (IEDITE.EXE).  IEdit was originally
  37. created for my own use, but caught on with the rapid growth of Windows 3.0,
  38. and now enjoys users from California to Austria!  If you're curious about 
  39. the technical aspects of IEdit and icons, read the Technical Information
  40. section at the end of this file.
  41.  
  42.  
  43.                              System Requirements
  44.  
  45. * Dos 3.0 or greater
  46. * A VGA system
  47. * Approximately 150k disk space (depending on number of icons)
  48. * At least 300k of free ram
  49. * 300-500k free disk space for swapping if SHELL feature is used
  50. * A Microsoft compatible mouse
  51. * Windows 3.0 (of course) to use your icons.
  52. * An 80286 based computer (AT or better).
  53.  
  54. NOTE: The shareware version of IEdit does NOT require an 80286.
  55.                                           
  56.                               
  57. Users who have a different system setup may be able to obtain a special
  58. version of IEdit from me.  Configurations include: An 8088 (XT class)
  59. version, and a version that does not require DOS 3.0 or greater.
  60.  
  61.  
  62.                               Creating Icons
  63.  
  64.              ───> Some of the functions in the following 
  65.                   instructions are not available in
  66.                   the Shareware version of IEdit <───
  67.  
  68.            (but this will give you an idea of what they do) 
  69.  
  70.      First, start IEdit by typing "IEDIT" at the DOS prompt, be sure that
  71. you've loaded your mouse's driver program beforehand (Usually MOUSE.COM).
  72.      The left side of your screen will have the main icon editing box.  The
  73. icons you create are actually a square of dots 32 by 32.  Each dot can be
  74. one of 16 colors (including black).  Icons also have another 32 by 32 square
  75. of dots (at the right center of IEdit) called an "invert mask".  You won't
  76. need an invert mask for most icons so we'll cover them later.
  77.      Between the main icon area and the invert mask is a color bar
  78. containing the 16 colors you can choose from.  Select a color by moving the
  79. mouse pointer over a color and clicking the left mouse button.  Above the
  80. icon area the upper "Current" color box will reflect your choice.  You can
  81. select a second  color with the right button, it will appear in the lower
  82. "Current" box.  The idea here is pick a main (upper) color for drawing with
  83. the left button, and a secondary (lower) color for drawing with the left
  84. button.  I like to choose my icon's background color for the lower color,
  85. that way I can erase mistakes quickly.
  86.      You can now move the mouse pointer over to the main icon area and use
  87. the either mouse button to draw a single dot.  You can also hold the button
  88. and move the mouse to draw continuously.  In the upper left corner you'll
  89. notice a tiny version of the main icon area, this is the actual size of the
  90. icon you're drawing.  You'll want to check this box to insure that your
  91. icon isn't too detailed to be seen when it's finished.  If you're trying to
  92. be precise you'll find the coordinate display (also above the main icon
  93. area) helpful, as well as the GRID function which puts a grid over the icon
  94. area (using your current upper color).
  95.      When you start drawing, the main icon area is black, so you can erase
  96. any mistakes by choosing the color "Black" from the color bar.  Later
  97. you'll see that you can start with any color you choose as the background,
  98. and then you'll need to use that color to "erase" a mistake.
  99.      Once you've created a suitable icon, choose VIEW from the function
  100. icons at the bottom.  You'll see a small Windows-like box in the center of
  101. the screen for a few seconds.  This is the way your icon (including the
  102. invert mask, if any) will look inside Windows.
  103.  
  104.  
  105.                         Saving and Loading icons
  106.  
  107.      You'll need to save your icon to a file in order to use it in Windows.
  108. If you're editing a previous icon, just choose SAVE and IEdit will
  109. replace the old icon file with the new one you're editing.  If you choose
  110. SAVE TO, or if you haven't previously saved the current one, you'll be
  111. prompted for a file name.  Type a name for your icon and press enter. IEdit
  112. will give your file name the extention "icn".  Don't choose a different
  113. extention since IEdit's LOAD function won't be able to find it if you do.
  114.      When you want to edit an icon, choose LOAD from the function bar.
  115. You'll be presented with a screen with all the icons in the current
  116. directory.  Just click on the icon you want to edit.  You can choose
  117. CANCEL to go back without loading an icon.  You can also choose NEW DIR
  118. and you'll be prompted for a new directory path.  BE SURE and give the full
  119. path (i.e. Drive etc.) such as "C:\Windows" or "C:\Icons".  If you know the
  120. name of the icon you want to edit, choose LOAD FROM, it will prompt you for a
  121. specific file name to edit.
  122.  
  123.  
  124.                          More editing functions
  125.  
  126.      The "buttons" along the edges of the main icon area will scroll the
  127. icon toward that edge, click on them to scroll your icon.  Likewise, the
  128. buttons below the invert mask are used to scroll it.  The CHAIN function
  129. allows you to link the two so that when you scroll either the icon or the
  130. invert mask, both will scroll.  Click on the CHAIN icon and you'll see a
  131. tiny links appear on it, click again to unlink.
  132.      The INVERT function lets you invert the colors in your icon.  The
  133. invert function is easier to use than to explain.  You can un-invert your
  134. icon by simply selecting INVERT a second time.
  135.      The CLEAR function will clear both the icon and the invert mask,
  136. and start over.  IEdit won't let you lose your work by clearing or loading
  137. without prompting you.  You'll see the message "Abandon this icon ([Y]/N)",
  138. you can press the right button for "Yes" or the left for "No", or press Y
  139. or N.  The CLEAR TO function is similar to the clear function except that it
  140. clears the icon to the "Current" selected color (instead of black).  The
  141. MOUSE icon lets you increase or decrease the sensitivity of your mouse.
  142. Click and hold on the right button to increase the sensitivity, or on the
  143. left button to decrease it.  You'll hear a rising or falling tone also.
  144. You may need to experiment to find the proper setting.
  145.      The CHG A CLR ("Change a color") function is simple, first choose the
  146. color in the icon that you wish to change.  Second click on the CHG A CLR
  147. icon, then click on your new color choice.  The first color will be replaced
  148. by the second throughout the icon.
  149.      The ROTATE function simply rotates your icon 90° clockwise.
  150.      The MIRROR function erases the right side of your icon and replaces it
  151. with a mirror image of the left side.  By using ROTATE and MIRROR you can make
  152. icons that are symmetric horizontally, vertically or both.
  153.      The UNDO function returns your icon to its state before the last
  154. function was executed (except LOAD).  You cannot undo manual drawing you have
  155. done.  You can use UNDO again to go back to the state before the first UNDO.
  156.  
  157.                             About Invert Masks
  158.  
  159.      Invert masks are a smaller version of an icon.  They do not use
  160. colors, each dot in an invert mask is either on (white) or off (black).
  161. When Windows is DISPLAYING (not moving) an icon, it uses the dots as a mask
  162. to determine where on the main icon to invert the colors.  My experience
  163. has been with VGA systems, other (particularly monochrome) systems may
  164. behave differently.  When an icon being MOVED, the invert mask is not used,
  165. but this is where invert masks have an effect.  Most often you'll want
  166. to make the black portions of your icon inverted.  This will make them the
  167. same as the background color in Windows.
  168.      For example:  Suppose you create two icons, both with red blocks at
  169. the center.  You make them nearly identical two different ways.  You can
  170. put a white background on one (example 1 below), and leave the other black,
  171. but give it an invert mask around the block (example 2).  This will invert the
  172. black to white in Windows.  So, you wind up with two icons that look
  173. identical; until you move them. Then you'll see that the one without the
  174. invert mask has a white area that runs over whatever you're moving over, in
  175. contrast the invert mask icon won't.  In addition, the inverted icon will
  176. change its background to the same as Windows', while the uninverted one will
  177. stay white.  In some cases, the invert mask icon will invert the colors behind
  178. it.  I realize this is difficult, I suggest you make a few icons for yourself
  179. and try them out.  The red tracer will appear to guide you if you manually
  180. edit an invert mask (it moves with you over the main icon).  Be sure and try
  181. the GUESS INV function first.  Also be sure to use the VIEW function, it uses
  182. the invert mask information in its display (The icon in the upper left corner
  183. does not).
  184.  
  185.             Example 1          ║           Example 2
  186.                                ║
  187.     ┌─────────┐  ┌─────────┐   ║   ┌─────────┐  ┌─────────┐
  188.     │██White██│  │         │   ║   │         │  │██White██│
  189.     │█▒▒▒▒▒▒▒█│  │         │   ║   │ ▒▒▒▒▒▒▒ │  │█       █│
  190.     │█▒▒RED▒▒█│  │         │   ║   │ ▒▒RED▒▒ │  │█       █│
  191.     │█▒▒▒▒▒▒▒█│  │         │   ║   │ ▒▒▒▒▒▒▒ │  │█       █│
  192.     │█████████│  │         │   ║   │         │  │█████████│
  193.     └─────────┘  └─────────┘   ║   └─────────┘  └─────────┘
  194.        icon      invert mask   ║      icon      invert mask
  195.      ┌──┴─────────────┘        ║        └────────────┴──┐
  196.      │                         ║                        │
  197.      │                         ║                        │
  198.      │    ┌─────────┐          ║         ┌─────────┐    │
  199.      │    │██White██│          ║         │██White██│    │
  200.      │    │█▒▒▒▒▒▒▒█│          ║         │█▒▒▒▒▒▒▒█│    │
  201.      └─>  │█▒▒RED▒▒█│          ║         │█▒▒RED▒▒█│  <─┘
  202.           │█▒▒▒▒▒▒▒█│          ║         │█▒▒▒▒▒▒▒█│
  203.           │█████████│          ║         │█████████│
  204.           └─────────┘          ║         └─────────┘
  205.            resulting           ║          resulting
  206.              icon              ║            icon
  207.                                ║
  208.     ∙ Background always white  ║   ∙ Background same as screen's
  209.  
  210.  
  211.  
  212.                            Pricing Information
  213.  
  214.           Product     Price    +    Shipping   =  Total   
  215.           ───────     ─────         ────────      ─────
  216.           
  217.           IEdit        $8              $1           $9
  218.           
  219.           Updates      $4              $1           $5
  220.  
  221.      Dollar amounts are U.S. funds.  Checks or money orders only; not
  222. responsible for cash lost in shipping.  Add $2 to total for shipping to UK and 
  223. Europe.  U.S. customers can avoid shipping charges by including a phone number
  224. for modem transfer (and a best time to call).
  225.      Minor revision updates (e.g. from 2.0 to 2.2) are free by modem to 
  226. registered users.  Registered users are notified when the next major version 
  227. is available.  Most orders shipped within 48 hours.  Checks are not cashed
  228. until product is shipped.  IEdit is guaranteed to perform reasonably, if you
  229. have a problem that cannot be solved, return the shipped materials within 10 
  230. days for a full refund of purchase amount.
  231.  
  232.  
  233.  
  234.                               Using IExtract
  235.  
  236.        (IExtract is included with the Enhanced version of IEdit)
  237.  
  238.      You can use IExtract to "rip" the icon out of an application.  The
  239. result is an icon file that you can edit and use like any other.  IExtract
  240. works with most, but not every Windows application.  The syntax is as
  241. follows from the DOS command line:
  242.  
  243.      IEXTRACT <Windows-application-filename> <Target-icon-filename>
  244.  
  245. You must specify both the source (application) and the target (.icn filename).
  246. IExtract will create the icon file at the path specified or in the current
  247. directory.  Typing "IEXTRACT" by itself will also give the command syntax.
  248.  
  249. Remember that the resulting icon is still under the copyright of the software
  250. company, and you may violate some software agreements by using IExtract.  
  251. Check with your software manufacturer for details.
  252.  
  253.  
  254.  
  255.                   Notes on recovering from errors and bugs
  256.  
  257. * It's possible that you have just enough free memory to load IEdit itself,
  258. but not enough for one of IEdit's functions.  IEdit traps for this, but I've
  259. been unable to test it.  In any case your current icon should be saved as
  260. "IEDITERR.ICN".
  261.  
  262. * IEdit has had some (heap-related) memory problems, if you have trouble, 
  263. try freeing up some memory before running IEdit.
  264.  
  265.  
  266.                   Technical and Miscellaneous Information
  267.  
  268. * IEdit itself was created with Microsoft's QuickPascal and now stands at
  269. roughly 2300 lines of code.  Despite the fact that IEdit had to overcome
  270. at least three bugs in QP, I still can't recommend it more highly.  The
  271. editor is very similar to Notepad (and indeed all MS products) and the
  272. Help is amazing (the manual rarely leaves the shelf).
  273.  
  274. * Why VGA only?  Well not entirely due to a lack of EGA graphic 
  275. capabilities, but more due to a lack of similar TEXT modes between the 
  276. two.  Keeping 640x480 and 640x350 straight is tricky enough without 
  277. dealing with text as well.  Ignoring that, EGA simply looks bad with
  278. 25% less resolution.  Also, most Windows users have a VGA anyway.  The 
  279. same applies to mice and '286 specific code.
  280.  
  281. * Why is it so cheap?  I'm a college student (Computer Information
  282. Sciences major, wanna hire me next year?) and I've done more than my share
  283. of "leeching" the Shareware market, so I priced IEdit so that I could have
  284. afforded to register it.  Also, I love to write software.  But the best
  285. result so far has been getting letters (and checks) from all over the
  286. WORLD(!).  I'd also like to thank people who called and wrote with comments
  287. and suggestions, they are reflected in this version.
  288.  
  289. * What else have I written?  Not much, IEdit is my first semi-serious
  290. venture into Shareware, but I did write an autoexec.bat multi-utility
  291. called Autoit.  It let's you speed up the keyboard rate, turn off the Num
  292. Lock, adjust the ram refresh rate, and check for a keystroke since boot-up
  293. (to branch out of the autoexec), all in one 5k program.
  294.  
  295. * My address: James Bell  4511 Sherwood Trace  Gainesville, Fl  32605.
  296. or call me at (904) 372-3695.
  297.  
  298. * Windows and QuickPascal are TM's of Microsoft Corp.
  299.  
  300. * Many thanks to Tom Wagner and (of course) Dr. Dobbs for the swap-to-
  301. disk ideas and examples.
  302.  
  303.                               What's next?
  304.  
  305. Version 3.x will have at least three new features, line, box and fill.
  306. These are worked out now (in my head), but not yet implemented and tested.
  307. I'd also like to speed up the entire workings some more and possibly convert
  308. the entire 60k+ source to C code.  
  309.  
  310. Thanks again, good luck, and happy Windows-ing!
  311. James Bell                                                     10/05/90
  312.